/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.dolphinscheduler.dao.mapper;

import org.apache.dolphinscheduler.dao.entity.DefinitionGroupByUser;
import org.apache.dolphinscheduler.dao.entity.DependentSimplifyDefinition;
import org.apache.dolphinscheduler.dao.entity.ProcessDefinition;

import org.apache.ibatis.annotations.MapKey;
import org.apache.ibatis.annotations.Param;

import java.util.Collection;
import java.util.List;
import java.util.Map;

import org.springframework.cache.annotation.CacheConfig;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.Cacheable;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.core.metadata.IPage;

/**
 * process definition mapper interface
 */
@CacheConfig(cacheNames = "processDefinition", keyGenerator = "cacheKeyGenerator")
public interface ProcessDefinitionMapper extends BaseMapper<ProcessDefinition> {

  /**
   * query process definition by code
   *
   * @param code code
   * @return process definition
   */
  @Cacheable(sync = true)
  ProcessDefinition queryByCode(@Param("code") long code);

  /**
   * update
   */
  @CacheEvict(key = "#p0.code")
  int updateById(@Param("et") ProcessDefinition processDefinition);

  /**
   * delete process definition by code
   *
   * @param code code
   * @return delete result
   */
  @CacheEvict
  int deleteByCode(@Param("code") long code);

  /**
   * query process definition by code list
   *
   * @param codes codes
   * @return process definition list
   */
  List<ProcessDefinition> queryByCodes(@Param("codes") Collection<Long> codes);

  /**
   * verify process definition by name
   *
   * @param projectCode projectCode
   * @param name        name
   * @return process definition
   */
  ProcessDefinition verifyByDefineName(@Param("projectCode") long projectCode,
                                       @Param("processDefinitionName") String name);

  /**
   * query process definition by name
   *
   * @param projectCode projectCode
   * @param name        name
   * @return process definition
   */
  ProcessDefinition queryByDefineName(@Param("projectCode") long projectCode,
                                      @Param("processDefinitionName") String name);

  /**
   * query process definition by id
   *
   * @param processDefineId processDefineId
   * @return process definition
   */
  ProcessDefinition queryByDefineId(@Param("processDefineId") int processDefineId);

  /**
   * process definition page
   *
   * @param page        page
   * @param searchVal   searchVal
   * @param userId      userId
   * @param projectCode projectCode
   * @return process definition IPage
   */
  IPage<ProcessDefinition> queryDefineListPaging(IPage<ProcessDefinition> page,
                                                 @Param("searchVal") String searchVal,
                                                 @Param("userId") int userId,
                                                 @Param("projectCode") long projectCode);

  /**
   * query all process definition list
   *
   * @param projectCode projectCode
   * @return process definition list
   */
  List<ProcessDefinition> queryAllDefinitionList(@Param("projectCode") long projectCode);

  /**
   * query process definition list
   *
   * @param projectCode projectCode
   * @return process definition list
   */
  List<DependentSimplifyDefinition> queryDefinitionListByProjectCodeAndProcessDefinitionCodes(@Param("projectCode") long projectCode,
                                                                                              @Param("codes") Collection<Long> codes);

  /**
   * query process definition by ids
   *
   * @param ids ids
   * @return process definition list
   */
  List<ProcessDefinition> queryDefinitionListByIdList(@Param("ids") Integer[] ids);

  /**
   * query process definition by tenant
   *
   * @param tenantId tenantId
   * @return process definition list
   */
  List<ProcessDefinition> queryDefinitionListByTenant(@Param("tenantId") int tenantId);

  /**
   * Statistics process definition group by project codes list
   * <p>
   * We only need project codes to determine whether the definition belongs to the user or not.
   *
   * @param projectCodes projectCodes
   * @return definition group by user
   */
  List<DefinitionGroupByUser> countDefinitionByProjectCodes(@Param("projectCodes") Long[] projectCodes);

  /**
   * list all resource ids
   *
   * @return resource ids list
   */
  @MapKey("id")
  List<Map<String, Object>> listResources();

  /**
   * list all resource ids by user id
   *
   * @return resource ids list
   */
  @MapKey("id")
  List<Map<String, Object>> listResourcesByUser(@Param("userId") Integer userId);

  /**
   * list all project ids
   *
   * @return project ids list
   */
  List<Integer> listProjectIds();
}
